Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add packages to requirements.txt, to fix import errors in sphinx #677

Merged
merged 1 commit into from
Sep 7, 2022

Conversation

jenhagg
Copy link
Collaborator

@jenhagg jenhagg commented Sep 7, 2022

Purpose

Generating docs for a given module requires importing it, so we need to install any packages it uses at the top level. E.g. the docs for europe_tub is missing for this reason.

What the code is doing

Add packages to requirements.txt and fix one place where the newline causes docs to not render properly (this one)

Testing

Built the docs locally.

Time estimate

1 min

@jenhagg jenhagg self-assigned this Sep 7, 2022
@jenhagg jenhagg requested review from rouille and BainanXia September 7, 2022 00:06
Copy link
Collaborator

@BainanXia BainanXia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@jenhagg jenhagg merged commit 1955c6f into develop Sep 7, 2022
@jenhagg jenhagg deleted the jen/docs branch September 7, 2022 00:24
@jenhagg jenhagg mentioned this pull request Dec 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants